Platform Explorer / Nuxeo Platform 2023.19

Operation NuxeoDrive.CreateFile (Nuxeo Drive: Create file)

Description

Create a document from the input blob in the container backing the file system item with the given id. Return the file system item backed by the created document as a JSON blob.
Operation id NuxeoDrive.CreateFile
Category Services
Label Nuxeo Drive: Create file
Requires
Since

Parameters

Name Description Type Required Default value
parentId Id of the file system item backed by the parent container. string yes  
overwrite Optional, whether to overwrite an existing document with the same title. boolean no false 

Signature

Inputs blob
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.drive.operations.NuxeoDriveCreateFile
Contributing Component org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

JSON Definition

{
  "id" : "NuxeoDrive.CreateFile",
  "label" : "Nuxeo Drive: Create file",
  "category" : "Services",
  "requires" : null,
  "description" : "Create a document from the input blob in the container backing the file system item with the given id. Return the file system item backed by the created document as a JSON blob.",
  "url" : "NuxeoDrive.CreateFile",
  "signature" : [ "blob", "blob" ],
  "params" : [ {
    "name" : "parentId",
    "description" : "Id of the file system item backed by the parent container.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "overwrite",
    "description" : "Optional, whether to overwrite an existing document with the same title.",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  } ]
}